/*
 * Copyright 2009 Jamie Gennis
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.code.gwt.remoteaction.client;

/**
 * An interface for classes that proxy the execution of a single action to an
 * action executor.
 *
 * @author jgennis
 */
public interface ActionProxy {

  /**
   * Set the ActionExecutor instance that the proxy will forward action
   * execution commands to.
   * 
   * @param actionExecutor the action executor instance (not null)
   */
  public void setActionExecutor(ActionExecutor actionExecutor);

  /**
   * Get the current ActionExecutor instance that the proxy will forward action
   * execution commands to.
   *
   * @return the current action executor
   */
  public ActionExecutor getActionExecutor();

  /**
   * An exception indicating that an ActionProxy instance was invoked before its
   * action executor was specified.
   *
   * @author jgennis
   */
  public static class NoActionExecutorSpecifiedException extends RuntimeException {

    /**
     * Creates a new instance of <code>NoActionExecutorSpecifiedException
     * </code> without detail message.
     */
    public NoActionExecutorSpecifiedException() {
    }
  }
}
